/***************************************************************************//**
 *   @file   ad9172.h
 *   @brief  Header file of ad9172 Driver.
 *   @author Cristian Pop (cristian.pop@analog.com)
********************************************************************************
 * Copyright 2018(c) Analog Devices, Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  - Neither the name of Analog Devices, Inc. nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *  - The use of this software may or may not infringe the patent rights
 *    of one or more patent holders.  This license does not release you
 *    from the requirement that you obtain separate licenses from these
 *    patent holders to use this software.
 *  - Use of the software either in source or binary form, must be run
 *    on or directly connected to an Analog Devices Inc. component.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
#ifndef __AD9172_H__
#define __AD9172_H__

#include "AD917x.h"
#include "delay.h"
#include "gpio.h"
#include "spi.h"

typedef struct ad9172_dev {
	/* SPI */
	spi_desc		*spi_desc;
	/* GPIO */
	struct gpio_desc	*gpio_reset;
	struct gpio_desc	*gpio_txen0;
	struct gpio_desc	*gpio_txen1;
	struct ad9172_state *st;
} ad9172_dev;

enum chip_id {
	CHIPID_AD9171 = 0x71,
	CHIPID_AD9172 = 0x72,
	CHIPID_AD9173 = 0x73,
	CHIPID_AD9174 = 0x74,
	CHIPID_AD9175 = 0x75,
	CHIPID_AD9176 = 0x76,
};

struct ad9172_state {
	enum chip_id id;
	ad917x_handle_t dac_h;
	jesd_param_t appJesdConfig;
	uint32_t dac_rate_khz;
	uint64_t dac_clkin_Hz;
	uint32_t dac_interpolation;
	uint32_t channel_interpolation;
	uint32_t interpolation;
	uint32_t jesd_link_mode;
	uint32_t jesd_dual_link_mode;
	uint32_t jesd_subclass;
	uint32_t clock_output_config;
	signal_type_t syncoutb_type;
	signal_coupling_t sysref_coupling;
	uint8_t nco_main_enable;
	uint8_t nco_channel_enable;
};

typedef struct ad9172_init_param {
	/* SPI */
	spi_init_param *spi_init;
	/* GPIO */
	struct gpio_init_param gpio_txen0;
	struct gpio_init_param gpio_txen1;
	struct gpio_init_param gpio_reset;
	uint32_t dac_rate_khz;
	uint32_t dac_clkin_Hz;
	uint32_t jesd_link_mode;
	uint32_t jesd_subclass;
	uint32_t dac_interpolation;
	uint32_t channel_interpolation;
	uint32_t clock_output_config;
	signal_type_t syncoutb_type;
	signal_coupling_t sysref_coupling;
} ad9172_init_param;

int32_t ad9172_init(ad9172_dev **device,
		    ad9172_init_param *init_param);
int32_t ad9172_remove(ad9172_dev *device);
#endif // __AD9172_H__
